home *** CD-ROM | disk | FTP | other *** search
/ PC World 2007 September / PCWorld_2007-09_cd.bin / v cisle / wireshark / wireshark-setup-0.99.6a.exe / README < prev    next >
Text File  |  2007-07-09  |  11KB  |  270 lines
  1. $Id: README 20602 2007-01-29 12:38:48Z jake $
  2.  
  3. General Information
  4. ------- -----------
  5.  
  6. Wireshark is a network traffic analyzer, or "sniffer", for Unix and
  7. Unix-like operating systems.  It uses GTK+, a graphical user interface
  8. library, and libpcap, a packet capture and filtering library.
  9.  
  10. The Wireshark distribution also comes with Tshark, which is a
  11. line-oriented sniffer (similar to Sun's snoop, or tcpdump) that uses the
  12. same dissection, capture-file reading and writing, and packet filtering
  13. code as Wireshark, and with editcap, which is a program to read capture
  14. files and write the packets from that capture file, possibly in a
  15. different capture file format, and with some packets possibly removed
  16. from the capture.
  17.  
  18. The official home of Wireshark is
  19.  
  20.     http://www.wireshark.org
  21.  
  22. The latest distribution can be found in the subdirectory
  23.  
  24.     http://www.wireshark.org/distribution
  25.  
  26.  
  27. Installation
  28. ------------
  29.  
  30. Wireshark is known to compile and run on the following systems:
  31.  
  32.   - Linux (2.0 and later kernels, various distributions)
  33.   - Solaris (2.5.1 and later)
  34.   - FreeBSD (2.2.5 and later)
  35.   - NetBSD
  36.   - OpenBSD
  37.   - Mac OS X (10.2 and later)
  38.   - HP-UX (10.20, 11.00, 11.11)
  39.   - Sequent PTX v4.4.5  (Nick Williams <njw@sequent.com>)
  40.   - Tru64 UNIX (formerly Digital UNIX) (3.2 and later)
  41.   - Irix (6.5)
  42.   - AIX (4.3.2, with a bit of work)
  43.   - Win32 (NT, 2000, 2003, XP)
  44.  
  45. and possibly on other versions of those OSes.  It should run on other
  46. Unix-ish systems without too much trouble.
  47.  
  48. NOTE: the Makefile appears to depend on GNU "make"; it doesn't appear to
  49. work with the "make" that comes with Solaris 7 nor the BSD "make".
  50. Perl is also needed to create the man page.
  51.  
  52. If you decide to modify the yacc grammar or lex scanner, then
  53. you need "flex" - it cannot be built with vanilla "lex" -
  54. and either "bison" or the Berkeley "yacc". Your flex
  55. version must be 2.5.1 or greater. Check this with 'flex -V'.
  56.  
  57. If you decide to modify the NetWare Core Protocol dissector, you
  58. will need python, as the data for packet types is stored in a python
  59. script, ncp2222.py.
  60.  
  61. You must therefore install Perl, GNU "make", "flex", and either "bison" or
  62. Berkeley "yacc" on systems that lack them.
  63.  
  64. Full installation instructions can be found in the INSTALL file.
  65.          
  66. See also the appropriate README.<OS> files for OS-specific installation
  67. instructions.
  68.  
  69. Usage
  70. -----          
  71.  
  72. In order to capture packets from the network, you need to be running as
  73. root, or have access to the appropriate entry under /dev if your system
  74. is so inclined (BSD-derived systems, and systems such as Solaris and
  75. HP-UX that support DLPI, typically fall into this category).  Although
  76. it might be tempting to make the Wireshark executable setuid root, please
  77. don't - alpha code is by nature not very robust, and liable to contain
  78. security holes.
  79.  
  80. Please consult the man page for a description of each command-line
  81. option and interface feature.
  82.  
  83.  
  84. Multiple File Types
  85. -------------------
  86.  
  87. The wiretap library is a packet-capture library currently under
  88. development parallel to wireshark.  In the future it is hoped that
  89. wiretap will have more features than libpcap, but wiretap is still in
  90. its infancy. However, wiretap is used in wireshark for its ability
  91. to read multiple file types. You can read the following file
  92. formats:
  93.  
  94. libpcap (tcpdump -w, etc.) - this is Wireshark's native format
  95. snoop and atmsnoop
  96. Shomiti/Finisar Surveyor
  97. Novell LANalyzer
  98. Network General/Network Associates DOS-based Sniffer (compressed and
  99.     uncompressed)
  100. Microsoft Network Monitor
  101. AIX's iptrace
  102. Cinco Networks NetXRray
  103. Network Associates Windows-based Sniffer
  104. AG Group/WildPackets EtherPeek/TokenPeek/AiroPeek/EtherHelp
  105. RADCOM's WAN/LAN Analyzer
  106. Lucent/Ascend access products
  107. HP-UX's nettl
  108. Toshiba's ISDN routers
  109. ISDN4BSD "i4btrace" utility
  110. Cisco Secure Intrustion Detection System iplogging facility
  111. pppd logs (pppdump-format files)
  112. VMS's TCPIPtrace utility
  113. DBS Etherwatch for VMS
  114. Traffic captures from Visual Networks' Visual UpTime
  115. CoSine L2 debug output
  116. Output from Accellent's 5Views LAN agents
  117. Endace Measurement Systems' ERF format
  118. Linux Bluez Bluetooth stack "hcidump -w" traces
  119. Network Instruments Observer version 9
  120. Trace files for the EyeSDN USB S0
  121.  
  122. In addition, it can read gzipped versions of any of these files
  123. automatically, if you have the zlib library available when compiling
  124. Wireshark. Wireshark needs a modern version of zlib to be able to use
  125. zlib to read gzipped files; version 1.1.3 is known to work.  Versions
  126. prior to 1.0.9 are missing some functions that Wireshark needs and won't
  127. work.  "./configure" should detect if you have the proper zlib version
  128. available and, if you don't, should disable zlib support. You can always
  129. use "./configure --disable-zlib" to explicitly disable zlib support.
  130.  
  131. Although Wireshark can read AIX iptrace files, the documentation on
  132. AIX's iptrace packet-trace command is sparse.  The 'iptrace' command
  133. starts a daemon which you must kill in order to stop the trace. Through
  134. experimentation it appears that sending a HUP signal to that iptrace
  135. daemon causes a graceful shutdown and a complete packet is written
  136. to the trace file. If a partial packet is saved at the end, Wireshark
  137. will complain when reading that file, but you will be able to read all
  138. other packets.  If this occurs, please let the Wireshark developers know
  139. at wireshark-dev@wireshark.org, and be sure to send us a copy of that trace
  140. file if it's small and contains non-sensitive data.
  141.  
  142. Support for Lucent/Ascend products is limited to the debug trace output
  143. generated by the MAX and Pipline series of products.  Wireshark can read
  144. the output of the "wandsession" "wandisplay", "wannext", and "wdd"
  145. commands.  For detailed information on use of these commands, please refer
  146. the following pages:
  147.  
  148. "wandsession", "wandisplay", and "wannext" on the Pipeline series:
  149.   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006c79
  150.  
  151. "wandsession", "wandisplay", and "wannext" on the MAX series:
  152.   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006972
  153.  
  154. "wdd" on the Pipeline series:
  155.   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006877
  156.  
  157. Wireshark can also read dump trace output from the Toshiba "Compact Router"
  158. line of ISDN routers (TR-600 and TR-650). You can telnet to the router
  159. and start a dump session with "snoop dump".
  160.  
  161. CoSine L2 debug output can also be read by Wireshark. To get the L2
  162. debug output, get in the diags mode first and then use
  163. "create-pkt-log-profile" and "apply-pkt-log-profile" commands under
  164. layer-2 category. For more detail how to use these commands, you
  165. should examine the help command by "layer-2 create ?" or "layer-2 apply ?".
  166.  
  167. To use the Lucent/Ascend, Toshiba and CoSine traces with Wireshark, you must 
  168. capture the trace output to a file on disk.  The trace is happening inside 
  169. the router and the router has no way of saving the trace to a file for you.
  170. An easy way of doing this under Unix is to run "telnet <ascend> | tee <outfile>".
  171. Or, if your system has the "script" command installed, you can save
  172. a shell session, including telnet to a file. For example, to a file named
  173. tracefile.out:
  174.  
  175. $ script tracefile.out
  176. Script started on <date/time>
  177. $ telnet router
  178. ..... do your trace, then exit from the router's telnet session.
  179. $ exit
  180. Script done on <date/time>
  181.  
  182.  
  183.  
  184. IPv6
  185. ----
  186. If your operating system includes IPv6 support, wireshark will attempt to
  187. use reverse name resolution capabilities when decoding IPv6 packets.
  188.  
  189. If you want to turn off name resolution while using wireshark, start
  190. wireshark with the "-n" option to turn off all name resolution (including
  191. resolution of MAC addresses and TCP/UDP/SMTP port numbers to names), or
  192. with the "-N mt" option to turn off name resolution for all
  193. network-layer addresses (IPv4, IPv6, IPX).
  194.  
  195. You can make that the default setting by opening the Preferences dialog
  196. box using the Preferences item in the Edit menu, selecting "Name
  197. resolution", turning off the appropriate name resolution options,
  198. clicking "Save", and clicking "OK".
  199.  
  200. If you would like to compile wireshark without support for IPv6 name
  201. resolution, use the "--disable-ipv6" option with "./configure".  If you
  202. compile wireshark without IPv6 name resolution, you will still be able to
  203. decode IPv6 packets, but you'll only see IPv6 addresses, not host names.
  204.  
  205.  
  206. SNMP
  207. ----
  208. Wireshark can do some basic decoding of SNMP packets; it can also use
  209. the Net-SNMP library to do more sophisticated decoding, by reading MIB
  210. files and using the information in those files to display OIDs and
  211. variable binding values in a friendlier fashion.  The configure script
  212. will automatically determine whether you have the Net-SNMP library on
  213. your system.  If you have the Net-SNMP library but _do not_ want to have
  214. wireshark use it, you can run configure with the "--without-net-snmp"
  215. option.
  216.  
  217. How to Report a Bug
  218. -------------------
  219. Wireshark is still under constant development, so it is possible that you will
  220. encounter a bug while using it. Please report bugs to wireshark-dev@wireshark.org.
  221. Be sure you tell us:
  222.  
  223.     1) Operating System and version (the command 'uname -sr' may
  224.        tell you this, although on Linux systems it will probably
  225.        tell you only the version number of the Linux kernel, not of
  226.        the distribution as a whole; on Linux systems, please tell us
  227.        both the version number of the kernel, and which version of
  228.        which distribution you're running)
  229.     2) Version of GTK+ (the command 'gtk-config --version' will tell you)
  230.     3) Version of Wireshark (the command 'wireshark -v' will tell you,
  231.        unless the bug is so severe as to prevent that from working,
  232.        and should also tell you the versions of libraries with which
  233.        it was built)
  234.     4) The command you used to invoke Wireshark, and the sequence of
  235.        operations you performed that caused the bug to appear
  236.  
  237. If the bug is produced by a particular trace file, please be sure to send
  238. a trace file along with your bug description. Please don't send a trace file
  239. greater than 1 MB when compressed. If the trace file contains sensitive
  240. information (e.g., passwords), then please do not send it.
  241.  
  242. If Wireshark died on you with a 'segmentation violation', 'bus error',
  243. 'abort', or other error that produces a UNIX core dump file, you can
  244. help the developers a lot if you have a debugger installed.  A stack
  245. trace can be obtained by using your debugger ('gdb' in this example),
  246. the wireshark binary, and the resulting core file.  Here's an example of
  247. how to use the gdb command 'backtrace' to do so.
  248.  
  249. $ gdb wireshark core
  250. (gdb) backtrace
  251. ..... prints the stack trace
  252. (gdb) quit
  253. $
  254.  
  255. The core dump file may be named "wireshark.core" rather than "core" on
  256. some platforms (e.g., BSD systems).  If you got a core dump with
  257. Tshark rather than Wireshark, use "tshark" as the first argument to
  258. the debugger; the core dump may be named "tshark.core".
  259.  
  260. Disclaimer
  261. ----------
  262.  
  263. There is no warranty, expressed or implied, associated with this product.
  264. Use at your own risk.
  265.  
  266.  
  267. Gerald Combs <gerald@wireshark.org>
  268. Gilbert Ramirez <gram@alumni.rice.edu>
  269. Guy Harris <guy@alum.mit.edu>
  270.